home *** CD-ROM | disk | FTP | other *** search
/ EuroCD 3 / EuroCD 3.iso / Programming / Python1.4_Source / Include / stringobject.h < prev    next >
C/C++ Source or Header  |  1998-06-24  |  3KB  |  88 lines
  1. #ifndef Py_STRINGOBJECT_H
  2. #define Py_STRINGOBJECT_H
  3. #ifdef __cplusplus
  4. extern "C" {
  5. #endif
  6.  
  7. /***********************************************************
  8. Copyright 1991-1995 by Stichting Mathematisch Centrum, Amsterdam,
  9. The Netherlands.
  10.  
  11.                         All Rights Reserved
  12.  
  13. Permission to use, copy, modify, and distribute this software and its
  14. documentation for any purpose and without fee is hereby granted,
  15. provided that the above copyright notice appear in all copies and that
  16. both that copyright notice and this permission notice appear in
  17. supporting documentation, and that the names of Stichting Mathematisch
  18. Centrum or CWI or Corporation for National Research Initiatives or
  19. CNRI not be used in advertising or publicity pertaining to
  20. distribution of the software without specific, written prior
  21. permission.
  22.  
  23. While CWI is the initial source for this software, a modified version
  24. is made available by the Corporation for National Research Initiatives
  25. (CNRI) at the Internet address ftp://ftp.python.org.
  26.  
  27. STICHTING MATHEMATISCH CENTRUM AND CNRI DISCLAIM ALL WARRANTIES WITH
  28. REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
  29. MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH
  30. CENTRUM OR CNRI BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
  31. DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
  32. PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  33. TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  34. PERFORMANCE OF THIS SOFTWARE.
  35.  
  36. ******************************************************************/
  37.  
  38. /* String object interface */
  39.  
  40. /*
  41. Type PyStringObject represents a character string.  An extra zero byte is
  42. reserved at the end to ensure it is zero-terminated, but a size is
  43. present so strings with null bytes in them can be represented.  This
  44. is an immutable object type.
  45.  
  46. There are functions to create new string objects, to test
  47. an object for string-ness, and to get the
  48. string value.  The latter function returns a null pointer
  49. if the object is not of the proper type.
  50. There is a variant that takes an explicit size as well as a
  51. variant that assumes a zero-terminated string.  Note that none of the
  52. functions should be applied to nil objects.
  53. */
  54.  
  55. /* NB The type is revealed here only because it is used in dictobject.c */
  56.  
  57. /* Take this out to save 4 bytes per string object and to lose 2% speedup */
  58. #define CACHE_HASH
  59.  
  60. typedef struct {
  61.     PyObject_VAR_HEAD
  62. #ifdef CACHE_HASH
  63.     long ob_shash;
  64. #endif
  65.     char ob_sval[1];
  66. } PyStringObject;
  67.  
  68. extern DL_IMPORT(PyTypeObject) PyString_Type;
  69.  
  70. #define PyString_Check(op) ((op)->ob_type == &PyString_Type)
  71.  
  72. extern PyObject *PyString_FromStringAndSize Py_PROTO((char *, int));
  73. extern PyObject *PyString_FromString Py_PROTO((char *));
  74. extern int PyString_Size Py_PROTO((PyObject *));
  75. extern char *PyString_AsString Py_PROTO((PyObject *));
  76. extern void PyString_Concat Py_PROTO((PyObject **, PyObject *));
  77. extern void PyString_ConcatAndDel Py_PROTO((PyObject **, PyObject *));
  78. extern int _PyString_Resize Py_PROTO((PyObject **, int));
  79. extern PyObject *PyString_Format Py_PROTO((PyObject *, PyObject *));
  80.  
  81. /* Macro, trading safety for speed */
  82. #define PyString_AS_STRING(op) ((op)->ob_sval)
  83.  
  84. #ifdef __cplusplus
  85. }
  86. #endif
  87. #endif /* !Py_STRINGOBJECT_H */
  88.